Skip to content

Improve README: explain the tool, document all CLI flags, add improvement roadmap#4

Merged
johnsirmon merged 2 commits into
mainfrom
copilot/improve-readme-and-documentation
Feb 22, 2026
Merged

Improve README: explain the tool, document all CLI flags, add improvement roadmap#4
johnsirmon merged 2 commits into
mainfrom
copilot/improve-readme-and-documentation

Conversation

Copilot AI commented Feb 22, 2026

Copy link
Copy Markdown
Contributor

The README lacked context about what HEIC is, how iCloud exports produce these zips, and was missing documentation for several CLI flags entirely.

Changes

Content additions

  • Background section explaining HEIC format, why it's not universally compatible, and the iCloud.com export workflow that produces the *icloud*.zip input files
  • Step-by-step iCloud photo export instructions so users know how to prepare input before running the tool

CLI documentation

  • Full reference table covering all 5 flags; --zip-pattern and --verbose were previously undocumented
  • Explicit note that --extract-dir is a temporary directory that is auto-deleted after conversion

Developer experience

  • pip install -e . dev install instructions (was absent)
  • heic-converter installed console script usage example
  • __main__.py added to project structure listing (was missing)

Opportunities to Improve section
Nine actionable enhancement ideas: output format flag (--format jpeg), parallel conversion via ThreadPoolExecutor, per-file error handling instead of aborting the batch, tqdm progress bar, EXIF metadata preservation, duplicate detection/skip, configurable --icloud-prefix, dry-run mode, and JPEG input support.

Badges
CI status, Python version, and license shields added to the header.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

…ent opportunities

Co-authored-by: johnsirmon <11774402+johnsirmon@users.noreply.github.com>
Copilot AI changed the title [WIP] Update README to improve clarity and explanation Improve README: explain the tool, document all CLI flags, add improvement roadmap Feb 22, 2026
Copilot AI requested a review from johnsirmon February 22, 2026 15:25
@johnsirmon johnsirmon marked this pull request as ready for review February 22, 2026 15:31
@johnsirmon johnsirmon merged commit 560a580 into main Feb 22, 2026
0 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants